Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update #5854

Merged
merged 7 commits into from
May 4, 2022
Merged

Documentation update #5854

merged 7 commits into from
May 4, 2022

Conversation

bmarty
Copy link
Member

@bmarty bmarty commented Apr 27, 2022

Improve the documentation of the project regarding default language.
Small cleanup
Add headers to SDK documentation. It will render like this:

image

(sadly I did not find a way to include links)

@github-actions
Copy link

github-actions bot commented Apr 27, 2022

Unit Test Results

114 files  ±0  114 suites  ±0   1m 11s ⏱️ -8s
202 tests ±0  202 ✔️ ±0  0 💤 ±0  0 ±0 
678 runs  ±0  678 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 246480e. ± Comparison against base commit 3d190bb.

♻️ This comment has been updated with latest results.

@bmarty bmarty force-pushed the feature/bma/small_fixies branch from 506d27f to a27ecac Compare April 27, 2022 15:31
@bmarty bmarty marked this pull request as ready for review April 28, 2022 07:42
@bmarty bmarty requested review from kittykat, a team, Claire1817 and mnaturel and removed request for a team April 28, 2022 07:42
CONTRIBUTING.md Show resolved Hide resolved
perPackageOption {
prefix.set("org.matrix.android.sdk.internal.legacy.riot")
matchingRegex.set("org.matrix.android.sdk.internal.legacy.riot")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now it's working fine. Outdated documentation of dokka :/


A few entry points:

- **Matrix**: The app will have to create and manage a Matrix object.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be nice to have link to the doc, but I did not find a way to make that work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmarty That may help you to add the correct references to classes: Kotlin/dokka#555 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I will have a look on that!

@bmarty bmarty changed the title Small fixies Documentation update Apr 28, 2022
@bmarty bmarty force-pushed the feature/bma/small_fixies branch from 8b64349 to 246480e Compare April 28, 2022 08:17
CONTRIBUTING.md Show resolved Hide resolved
@bmarty bmarty merged commit dcc20bb into develop May 4, 2022
@bmarty bmarty deleted the feature/bma/small_fixies branch May 4, 2022 09:57
@bmarty bmarty mentioned this pull request May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants